[WIP] CVar rework #2552
[WIP] CVar rework #2552
Conversation
| @@ -4971,7 +4972,7 @@ void Interface_Draw(PlayState* play) { | |||
| break; | |||
| } | |||
| } else { | |||
| if (CVarGetInteger("gCosmetics.Consumable_GreenRupee.Changed", rupeeWalletColors)) { | |||
| if (CVarGetInteger("gCosmetics.Consumable_GreenRupee.Changed", 0)) { | |||
There was a problem hiding this comment.
As a note, this is a bug caught by the checks I added in the new CVars system. The default value was a pointer, instead of 0 (false) that it was everywhere else.
|
I've gone through this @Rozelette! I started here (and have not checked LUS) because when designing new systems I think its most important what it feels like to the user. I really love the concept of everything just being vars that you can use in code and not having to worry about fetching and default values at the usage point. One thing that I wonder if can be improved is that it's a 3 step process to make a new var. You add it to some struct, you register the default value for that property and then you register it as a Cvar (being persistable) if it needs to be persisted. I wonder if there's any way we can achieve that with just one structure? Perhaps code generation? Perhaps a macro? Given that we're working in C-land that may not be possible but wanted to get gears turning. It might not be possible but it would be great to be able to do something like: // key that will be used, type, default value, persisted
CreateVar("global.language", s32, LANGUAGE_ENG, true);
CreateVar("global.zTargetSetting", s32, 0, false);which maybe generates: typedef struct {
s32 language;
s32 zTargetSetting;
} global;
global.language = LANGUAGE_ENG;
global.zTargetSetting = 0;
cvar->RegisterManaged("gLanguage", global.language); |
This is a WIP example of reworking CVars to solve several issues with them. This is the SoH side of things, for the LUS PR, see Kenix3/libultraship#137.
The issues I am trying to fix:
The changes needed in SoH are less structural, and more just needed as a client of the new interface. They do present an example of the intended interface. This PR reworks the values previously held in
global.savto be the new version of CVars. As such, they no longer need to be saved, since they will be saved with the CVars. Let's see what was needed to convert them.GlobalSettings.h/.cppandz64settings.hz64settings.hcontains a global struct of settings that exist outside of any file-specific data. Data was moved out fromgSaveContextaccordingly.GlobalSettingsis the C++ side of things and manages defaulting and associating the data with CVars.So, to add a new setting and associated CVar you:
z64settings.hGlobalSettings.cppGlobalSettings.cppThat's it! Now you can use it just like a regular C variable and it'll get saved along with all the other CVars.
Update: made a second commit to show how to convert the existing usage into the new usage.